<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>&quot;utils/pathToRegex&quot; | opine</title>
	<meta name="description" content="Documentation for opine">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">opine</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../globals.html">Globals</a>
				</li>
				<li>
					<a href="_utils_pathtoregex_.html">&quot;utils/pathToRegex&quot;</a>
				</li>
			</ul>
			<h1>Module &quot;utils/pathToRegex&quot;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>Port of path-to-regexp (<a href="https://github.com/pillarjs/path-to-regexp/tree/v0.1.7">https://github.com/pillarjs/path-to-regexp/tree/v0.1.7</a>) for Deno.</p>
					</div>
					<p>Licensed as follows:</p>
					<p>The MIT License (MIT)</p>
					<p>Copyright (c) 2014 Blake Embrey (<a href="mailto:&#x68;&#101;&#x6c;&#108;&#x6f;&#x40;&#98;&#x6c;&#x61;&#107;&#x65;&#101;&#109;&#98;&#114;&#101;&#x79;&#46;&#99;&#x6f;&#x6d;">&#x68;&#101;&#x6c;&#108;&#x6f;&#x40;&#98;&#x6c;&#x61;&#107;&#x65;&#101;&#109;&#98;&#114;&#101;&#x79;&#46;&#99;&#x6f;&#x6d;</a>)</p>
					<p>Permission is hereby granted, free of charge, to any person obtaining a copy
						of this software and associated documentation files (the &quot;Software&quot;), to deal
						in the Software without restriction, including without limitation the rights
						to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
						copies of the Software, and to permit persons to whom the Software is
					furnished to do so, subject to the following conditions:</p>
					<p>The above copyright notice and this permission notice shall be included in
					all copies or substantial portions of the Software.</p>
					<p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
						IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
						FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
						AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
						LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
						OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
					THE SOFTWARE.</p>
				</div>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Type aliases</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_utils_pathtoregex_.html#path" class="tsd-kind-icon">Path</a></li>
								<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_utils_pathtoregex_.html#patharray" class="tsd-kind-icon">Path<wbr>Array</a></li>
							</ul>
						</section>
						<section class="tsd-index-section tsd-is-not-exported">
							<h3>Variables</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported"><a href="_utils_pathtoregex_.html#matching_group_regexp" class="tsd-kind-icon">MATCHING_<wbr>GROUP_<wbr>REGEXP</a></li>
							</ul>
						</section>
						<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function tsd-parent-kind-module tsd-is-private"><a href="_utils_pathtoregex_.html#pathtoregexp" class="tsd-kind-icon">path<wbr>ToRegexp</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Type aliases</h2>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="path" class="tsd-anchor"></a>
					<h3>Path</h3>
					<div class="tsd-signature tsd-kind-icon">Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> | </span><a href="_utils_pathtoregex_.html#patharray" class="tsd-signature-type">PathArray</a></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine/blob/bc9a2ab/src/utils/pathToRegex.ts#L35">home/runner/work/opine/opine/src/utils/pathToRegex.ts:35</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
					<a name="patharray" class="tsd-anchor"></a>
					<h3>Path<wbr>Array</h3>
					<div class="tsd-signature tsd-kind-icon">Path<wbr>Array<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine/blob/bc9a2ab/src/utils/pathToRegex.ts#L34">home/runner/work/opine/opine/src/utils/pathToRegex.ts:34</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
				<h2>Variables</h2>
				<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
					<a name="matching_group_regexp" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> MATCHING_<wbr>GROUP_<wbr>REGEXP</h3>
					<div class="tsd-signature tsd-kind-icon">MATCHING_<wbr>GROUP_<wbr>REGEXP<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span><span class="tsd-signature-symbol"> = /\((?!\?)/g</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/cmorten/opine/blob/bc9a2ab/src/utils/pathToRegex.ts#L32">home/runner/work/opine/opine/src/utils/pathToRegex.ts:32</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Match matching groups in a regular expression.</p>
						</div>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-private">
					<a name="pathtoregexp" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagPrivate">Private</span> path<wbr>ToRegexp</h3>
					<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-private">
						<li class="tsd-signature tsd-kind-icon">path<wbr>ToRegexp<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="_utils_pathtoregex_.html#path" class="tsd-signature-type">Path</a>, keys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RegExp</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/cmorten/opine/blob/bc9a2ab/src/utils/pathToRegex.ts#L52">home/runner/work/opine/opine/src/utils/pathToRegex.ts:52</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Normalize the given path string,
									returning a regular expression.</p>
								</div>
								<p>An empty array should be passed,
									which will contain the placeholder
									key names. For example &quot;/user/:id&quot; will
								then contain [&quot;id&quot;].</p>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>path: <a href="_utils_pathtoregex_.html#path" class="tsd-signature-type">Path</a></h5>
								</li>
								<li>
									<h5>keys: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
								</li>
								<li>
									<h5>options: <span class="tsd-signature-type">any</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
					<li class="current tsd-kind-module">
						<a href="_utils_pathtoregex_.html">&quot;utils/path<wbr>ToRegex&quot;</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_utils_pathtoregex_.html#path" class="tsd-kind-icon">Path</a>
					</li>
					<li class=" tsd-kind-type-alias tsd-parent-kind-module">
						<a href="_utils_pathtoregex_.html#patharray" class="tsd-kind-icon">Path<wbr>Array</a>
					</li>
					<li class=" tsd-kind-variable tsd-parent-kind-module tsd-is-not-exported">
						<a href="_utils_pathtoregex_.html#matching_group_regexp" class="tsd-kind-icon">MATCHING_<wbr>GROUP_<wbr>REGEXP</a>
					</li>
					<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-private">
						<a href="_utils_pathtoregex_.html#pathtoregexp" class="tsd-kind-icon">path<wbr>ToRegexp</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
				<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>